<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head><title>mx.fmxis.FMXISBarrelDial Class</title><link rel="stylesheet" type="text/css" href="../../../docs.css"></link></head><body><h1>FMXISBarrelDial Class</h1><p><b>Class </b>mx.fmxis.FMXISBarrelDial</p><p><b>Inheritance </b>
			
			&gt;
			
		<a href="../FMXISBase/Class.htm">FMXISBase</a>
			
			&gt;
			
		<a href="Class.htm">FMXISBarrelDial</a></p><div class="description">This class implements a simple barrel dial that displays
positive integer values.  The values can increase by rolling the display
upwards or downwards (depending on parameter set in the component parameter panel).
<br /><br />
<p>The class has one event, "onOverflow", indicating the current value has exceeded
the maximum value of the display.  The value is passed as the value of the event.</p>
<br /><br />
<p>Users can change the appearance by modifying:</p>
<br /><br />
<li><code>defBDialBkgnd</code> - background for digit</li>
<li><code>defBDialDigGfx</code> - clip with digits used</li>
<li><code>defBDialDigPlusBkgnd</code> - movie clip that contains two digits
(one in regular space for digit, one above) &amp; background</li>
<br /><br />
<p>This class inherits from FMXISBase to get listener capabilities.</p></div><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Property Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#className">className</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">Array</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#dialEvents">dialEvents</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#digTint">digTint</a></div><div class="functionSummaryLine">Color of each digit.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#display">display</a></div><div class="functionSummaryLine">Whether or not to display the digit value.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#evtOverflow">evtOverflow</a></div><div class="functionSummaryLine">Event name for event generated if the value of the display (whole number) exceeds the
number of positions.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#numDigs">numDigs</a></div><div class="functionSummaryLine">Number of digits.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#rollUp">rollUp</a></div><div class="functionSummaryLine">Whether the dial increases by rolling up (true) or down (false).</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#showBkgnd">showBkgnd</a></div><div class="functionSummaryLine">Whether or not to display the background graphic.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolName">symbolName</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">Object</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolOwner">symbolOwner</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#val">val</a></div><div class="functionSummaryLine">A getter/setter property used to set or retrieve the value of the dial.</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Properties inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addEventListener">addEventListener</a>, <a href="../FMXISBase/Class.htm#clipParameters">clipParameters</a>, <a href="../FMXISBase/Class.htm#removeEventListener">removeEventListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Method Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#setColor">setColor</a>(c)</div><div class="functionSummaryLine">Sets the tint color of the digits to the given color.</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Methods inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addListener">addListener</a>, <a href="../FMXISBase/Class.htm#init">init</a>, <a href="../FMXISBase/Class.htm#removeListener">removeListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Event Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#onOverflow">onOverflow</a></div><div class="functionSummaryLine">This component generates an event named "onOverflow" (can be changed programmatically or through the
component parameter panel) when the barrel dial exceeds its maximum value.</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Property Detail</th></tr></table><div class="DetailRow"><a name="className"></a><div class="DetailObjectTitle">className</div><div class="DetailObjectDeclaration"> var className:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="dialEvents"></a><div class="DetailObjectTitle">dialEvents</div><div class="DetailObjectDeclaration"> static var dialEvents:Array;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="digTint"></a><div class="DetailObjectTitle">digTint</div><div class="DetailObjectDeclaration">public function get/set digTint()</div><div class="DetailDescription">Color of each digit.</div></div><div class="DetailRow"><a name="display"></a><div class="DetailObjectTitle">display</div><div class="DetailObjectDeclaration">public function get/set display()</div><div class="DetailDescription">Whether or not to display the digit value.  This is used to simulate the
display on (true) or off (false).</div></div><div class="DetailRow"><a name="evtOverflow"></a><div class="DetailObjectTitle">evtOverflow</div><div class="DetailObjectDeclaration">public var evtOverflow:String;</div><div class="DetailDescription">Event name for event generated if the value of the display (whole number) exceeds the
number of positions.  Unlike the digital display, the barrel
dial does not handle negative numbers.</div></div><div class="DetailRow"><a name="numDigs"></a><div class="DetailObjectTitle">numDigs</div><div class="DetailObjectDeclaration">public function get/set numDigs()</div><div class="DetailDescription">Number of digits.  This can be set only in the component property panel.</div></div><div class="DetailRow"><a name="rollUp"></a><div class="DetailObjectTitle">rollUp</div><div class="DetailObjectDeclaration">public function get/set rollUp()</div><div class="DetailDescription">Whether the dial increases by rolling up (true) or down (false).</div></div><div class="DetailRow"><a name="showBkgnd"></a><div class="DetailObjectTitle">showBkgnd</div><div class="DetailObjectDeclaration">public function get/set showBkgnd()</div><div class="DetailDescription">Whether or not to display the background graphic.</div></div><div class="DetailRow"><a name="symbolName"></a><div class="DetailObjectTitle">symbolName</div><div class="DetailObjectDeclaration"> static var symbolName:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="symbolOwner"></a><div class="DetailObjectTitle">symbolOwner</div><div class="DetailObjectDeclaration"> static var symbolOwner:Object;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="val"></a><div class="DetailObjectTitle">val</div><div class="DetailObjectDeclaration">public function get/set val()</div><div class="DetailDescription">A getter/setter property used to set or retrieve the value of the dial.</div><div class="DetailsExampleTitle">Example</div><div class="DetailsExampleLine">// set the barrel display to 3-2, in which rightmost digit (2) is half way between 2 and 3.
myBDial.val = 32.5;</div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Method Detail</th></tr></table><div class="DetailRow"><a name="setColor"></a><div class="DetailObjectTitle">setColor</div><div class="DetailObjectDeclaration"> function  setColor(c)</div><div class="DetailDescription">Sets the tint color of the digits to the given color.</div><div class="DetailParamsTitle">Parameters:</div><div class="DetailParamsLine"><code>RGBColor</code> - RGB value (typically hexadecimal values for Red, Green, and Blue)</div><div class="DetailsExampleTitle">Example</div><div class="DetailsExampleLine">myBDial.setColor(0xFF0000); // sets digits to pure red</div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Event Detail</th></tr></table><div class="DetailRow"><a name="onOverflow"></a><div class="DetailObjectTitle">onOverflow</div><div class="DetailObjectDeclaration"> function  onOverflow(<i>eventObj</i>)</div><div class="DetailDescription">This component generates an event named "onOverflow" (can be changed programmatically or through the
component parameter panel) when the barrel dial exceeds its maximum value.  Note: underflow
(i.e., a value below 0) is not caught in this implementation.</div></div><br /><br /><hr /><span style='font-size: x-small; font-family: Verdana, Arial'>Documentation generated by <a href='http://wwww.blinex.com/products/bldoc' target='_blank' alt='BLDoc Link'>BLDoc Community Edition</a> from <a href='http://www.blinex.com' target='_blank' alt='B-Line Express Website'>B-Line Express</a>.</body></html>